SftTree/OCX 7.0

DataObject.GetFormat Method

Softel vdm, Inc.

Determines if a specified clipboard format is supported by the DataObject object.

Syntax       

VB.NET

FormatSupported = object.GetFormat(ByVal Format As Short)  As Boolean

VB

FormatSupported = object.GetFormat(ByVal Format As Integer)  As Boolean

C#.NET

bool FormatSupported = object.GetFormat(short Format);

VC++

VARIANT_BOOL FormatSupported = object->GetFormat(short Format);

C

HRESULT object->raw_GetFormat(short Format, VARIANT_BOOL* FormatSupported);

Delphi

FormatSupported := object.GetFormat(Format : Smallint)   : WordBool;

object

A DataObject object.

Format

The data format requested (see SftOLEClipboardConstants).

Format

Value

Description

sftCFText

1

Text

sftCFBitmap

2

Bitmap

sftCFMetafile

3

Metafile

sftCFDIB

8

Device independent bitmap

sftCFFiles

15

List of files

sftCFRTF

-16639

Rich text format

FormatSupported

Returns True if the specified clipboard format Format is supported by the DataObject object, otherwise False is returned.

Comments

The GetFormat method determines if a specified clipboard format is supported by the DataObject object.

The GetFormat method returns True if a data format in the DataObject object matches the specified format.  Otherwise, it returns False.

See Also  DataObject Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com